docs(readme): 新增安装方式：uv#20
Merged
MistEO merged 2 commits intoMAA-AI:mainfrom Dec 26, 2025
Merged
Conversation
另外：如果用户使用非全局 python ，在 Cherry Studio 中是无法直接使用的 解决方案：直接用 uvx
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Hey - 我在这里给出了一些总体反馈：
- 建议简单提一下
uvx依赖已安装的uv，并附上链接或安装提示，这样不熟悉uv的用户也能了解如何使用推荐的方式。 - 既然现在推荐使用
uvx maa-mcp，那么在 Cherry Studio 配置部分中，可能需要说明通过pip安装的用户仍然可以直接使用maa-mcp命令，以避免两种调用方式之间产生混淆。
给 AI Agent 的提示词
Please address the comments from this code review:
## Overall Comments
- Consider briefly mentioning that `uvx` requires `uv` to be installed and linking or hinting at how to install it, so users unfamiliar with `uv` understand how to use the recommended method.
- Since `uvx maa-mcp` is now the recommended way, it may be helpful to clarify in the Cherry Studio configuration section that users who installed via `pip` can still use the plain `maa-mcp` command, to avoid confusion between the two invocation methods.帮我变得更有用！请在每条评论上点选 👍 或 👎，我会根据你的反馈改进后续的审查。
Original comment in English
Hey - I've left some high level feedback:
- Consider briefly mentioning that
uvxrequiresuvto be installed and linking or hinting at how to install it, so users unfamiliar withuvunderstand how to use the recommended method. - Since
uvx maa-mcpis now the recommended way, it may be helpful to clarify in the Cherry Studio configuration section that users who installed viapipcan still use the plainmaa-mcpcommand, to avoid confusion between the two invocation methods.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- Consider briefly mentioning that `uvx` requires `uv` to be installed and linking or hinting at how to install it, so users unfamiliar with `uv` understand how to use the recommended method.
- Since `uvx maa-mcp` is now the recommended way, it may be helpful to clarify in the Cherry Studio configuration section that users who installed via `pip` can still use the plain `maa-mcp` command, to avoid confusion between the two invocation methods.Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
There was a problem hiding this comment.
Pull request overview
This PR updates the documentation to recommend uv/uvx as the primary installation method for maa-mcp, addressing an issue where users with non-global Python installations cannot directly use the package in Cherry Studio.
Key changes:
- Promotes
uvxto the recommended (first) installation method - Updates the Cherry Studio configuration example to use
uvx maa-mcp - Reorders existing installation methods (pip becomes method 2, source installation becomes method 3)
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+79
to
+83
| #### 方式一：通过 uv 安装（推荐） | ||
|
|
||
| ```bash | ||
| uvx maa-mcp | ||
| ``` |
There was a problem hiding this comment.
The section title says "通过 uv 安装" (Install via uv), but the command uvx maa-mcp doesn't actually install the package - it runs it in an ephemeral environment. Consider either:
- Changing the title to "方式一：通过 uvx 运行（推荐）" to reflect that it runs rather than installs, or
- Adding explanation that uvx automatically manages the package in an isolated environment without requiring explicit installation.
This will help users understand that they don't need a separate installation step when using uvx.
Add installation instructions for uv.
Collaborator
|
英文文档也一起改下？ |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
另外：如果用户使用非全局 python ，在 Cherry Studio 中是无法直接使用的
解决方案：直接用 uvx
由 Sourcery 提供的总结
将基于 uv 的安装记录为主要推荐方法，并相应更新使用示例。
文档：
uvx调用 MCP，而不是直接使用maa-mcp命令。Original summary in English
Summary by Sourcery
Document uv-based installation as the primary recommended method and update usage examples accordingly.
Documentation: